Skip to main content

assistantInfo

AssistantInfo Model​

Represents the minimal assistant information required to initialize and configure the chat-ui (ShowQuestion) component.

id (integer, ReadOnly)​

Unique identifier of the assistant. Automatically assigned by the system.

info (string, Nullable, Optional)​

Display name or identifier for the assistant in the chat interface. This field is customizable from the implementation portal and enables assistant personalization in the chat-ui.

Note: If null, the chat-ui should use a default or fallback assistant name.

description (string) Required​

A short summary describing the assistant's purpose or scope. Displayed to users to understand the assistant's capabilities.

initial_message (string, Optional)​

The welcome message with which the assistant starts the conversation. This message is displayed to the user when initiating a new chat session.

max_msg_length (integer, Optional)​

Maximum length of each message in characters. Used by the chat-ui to enforce message size limits and provide user feedback when approaching the limit.

async_available (boolean, Optional)​

Indicates whether the assistant supports asynchronous chat creation and processing.

streaming_available (boolean, Optional)​

Indicates whether the assistant supports real-time streaming responses. If true, the chat-ui can display responses as they are generated incrementally rather than waiting for the complete response.

matrix_mode_available (boolean, Optional)​

Indicates whether the assistant supports matrix mode, a specialized interaction mode. The chat-ui uses this flag to enable or disable the matrix mode interface option.

realtime_available (boolean, Optional)​

Indicates whether the assistant supports real-time chat capabilities. Determines if the chat-ui can establish real-time connections for live interaction.

logo (string, Nullable, Optional)​

URL to the assistant's logo or avatar image. This field is customizable from the implementation portal and is displayed in the chat interface header or assistant selector.

Note: If null or empty string, the chat-ui should display a default placeholder image.

colors (object, Nullable, Optional)​

An object containing custom color configuration for the chat interface. This field is customizable from the implementation portal and enables consistent branding. Contains the following properties:

  • nameColor (string, Nullable): Hex color code for the assistant's display name
  • borderColor (string, Nullable): Hex color code for UI element borders
  • primaryColor (string, Nullable): Hex color code for primary UI elements and buttons
  • secondaryColor (string, Nullable): Hex color code for secondary UI elements and accents

Note: If null, the chat-ui should apply default color scheme. Individual color properties may also be null, in which case defaults should be used for those specific elements.

Example colors object:

{
  "nameColor": "#130d01",
  "borderColor": "#e98c12",
  "primaryColor": "#f49b0d",
  "secondaryColor": "#0abaa8"
}

web_search_enabled (boolean, Optional)​

Indicates whether web search is enabled for the assistant.

web_search_allowed_domains (array[string] or null, Optional)​

Allowed domains for web search. If set, the backend normalizes and validates the domain list.

web_search_location (object or null, Optional)​

Optional location information used to localize web search.

web_search_mode (string, Optional)​

Web search mode.

  • Enum: agentic, deep_research

attachment_config (object or null, Optional)​

Per-assistant file handling configuration, keyed by content type. Each content type can define whether files are accepted, whether they are sent to the model, and for PDFs whether pdf_mode is image or text.